Web Service: PathWayService

Port type PathWayServiceSoapSource code

1. CheckCapacitySummary
   Source code
   Description:
   Returns an ordered, filtered list of services based on the specified search criteria (representing patient need).
   Style:
   document
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   https://nww.pathwaysdos.nhs.uk/app/api/webservices/CheckCapacitySummary
   Input:
   CheckCapacitySummarySoapIn (soap12:header, use = literal, part = ServiceVersion)Source code
   parameters type CheckCapacitySummary

   • userInfo type UserInfo
     • username type string
     • password type string
   • c type Case
     The case details representing the clincial scenario for the search.
     • caseRef - optional; type string
       A globally unique identifier for the case record representing the clinical scenario on the consumer side.
     • caseId - optional; type string
       A 'friendly' identifier for the case record representing the clinical scenario on the consumer side.
     • postcode type string
       The postcode of the location from which to perform the search (e.g. the patient's current location).
     • surgery - optional; type string
       The ODS code of the patient's registered surgery. You can use 'UNK' if not known.
     • age type short
       The age value for the patient. Range of accepted values will differ according to the AgeFormat that is used.
     • ageFormat type AgeFormatType - type string with restriction - enum { 'Days', 'Months', 'Years', 'AgeGroup' }
       The type / format of the age value that is being provided (e.g. Years, Days, AgeGroup)
     • disposition type int
       A code representing the clinical disposition of the clinical scenario. List of valid Disposition codes is maintained separately and will change periodically.
     • symptomGroup type int
       A numerical code indicating the Symptom Group to be used for the search. List of valid Symptom Group codes is maintained separately and will change periodically.
     • symptomDiscriminatorList type ArrayOfInt
       A list of numerical codes indicating the Symptom Discriminators to be used for the search. List of valid Symptom Discriminator codes is maintained separately and will change periodically. NOTE: Although this is a list, only one list item is currently expected in the request.
       • int - optional, unbounded; type int
     • searchDistance - optional; type int
       The maximum distance within which to return services from the specified postcode (measured as a straight line). Value in kilometres (KM). Only required to override the default search distances.
     • forceSearchDistance type boolean
       A boolean indicating that the supplied searchDistance value should be used for the search over all other sources for the search distance value (e.g. will override the server-side default search distance for the postcode).
     • gender type GenderType - type string with restriction - enum { 'M', 'F', 'I' }
       The stated gender of the patient.
     • searchDateTime - optional; type string
       An optional timestamp which can be used to "Perform the search as if it is X timestamp in the future". Should be used for scenario testing / modelling. Should be omitted for searches relating to real clinical scenarios.
   Output:
   CheckCapacitySummarySoapOut (soap12:body, use = literal)Source code
   parameters type CheckCapacitySummaryResponse

   • TransactionId type string
     A globally unique identifier representing the search transaction. Generated by the server at time of request.
   • RequestedAtDateTime type string
     Timestamp of when the search request transaction was completed (i.e. time now).
   • SearchDateTime type string
     Timestamp used for the purpose of the search scenario (i.e. The search results are returned as if current time is this timestamp).
   • CalculatedAgeInDays - optional; type float
     The patient's age used for the purpose of the search scenario (in days).
   • SearchDistance type int
     The search distance used for the purpose of the search scenario. Value in kilometres (KM).
   • SearchDistanceUsedSource type DistanceSource - type string with restriction - enum { 'Postcode', 'District', 'Sector', 'Override', 'National' }
     The source used to populate the search distance used in the search scenario.
   • CheckCapacitySummaryResult type ArrayOfServiceCareSummaryDestination
     An ordered, filtered list of service results.
     • serviceCareSummaryDestination - optional, unbounded, nillable; type ServiceCareSummaryDestination
       • id type int
         The identifier for the service.
       • capacity type Capacity - type string with restriction - enum { 'High', 'Low', 'None' }
         The current capacity of the service.
       • name - optional; type string
         The profiled name of the service.
       • publicName - optional; type string
         An alternative public-friendly / familiar name for the service.
       • contactDetails - optional; type string
         Contact details for the service (e.g. a public telephone number).
       • address - optional; type string
         The address of the service.
       • postcode - optional; type string
         The postcode of the service.
       • northings - optional; type int
         The northings value for the service, based on the service postcode.
       • eastings - optional; type int
         The eastings value for the service, based on the service postcode.
       • url - optional; type string
         A URL for the service.
       • serviceType type ServiceType
         The type of the service (as per a maintained list of possible service types).
         • id type long
           The identifier for the service type.
         • name type string
           The name of the service type.
       • odsCode - optional; type string
         The value of the ODS code field for the service. NOTE: Values in this field are not automatically validated, and therefore cannot be considered guarranteed ODS codes at present
       • nonPublicTelephoneNo - optional; type string
         A telephone number for the service for use by health and care professionals only - should not be displayed or shared publicly.
       • fax - optional; type string
         A fax number for the service - should not be assumed safe to display or share publicly.
       • publicFacingInformation - optional; type string
         Free text notes about using the service. These notes can be displayed / shared publicly.
       • distance - optional; type string
         The distance between the specified search location and the service (straight line). Value in miles (mi).
       • referralInformation - optional; type string
         Free text notes about referring to the service - for health and care professional use only. These notes should not be displayed / shared publicly.
       • openAllHours type boolean
         A boolean representing whether the service is always open - always open indicated by a 'true' value.
       • capacityAttributes - optional; type ArrayOfCapacityAttributes
         A list of attributes describing the capacity of the service. A list of valid capacity attributes is maintained separately - new attribute items can be introduced outside of the schema. Absence of an attribute in the list signifies that it is not populated for the service.
         • capacityAttribute - unbounded, nillable; type CapacityAttribute
           A list of capacity attributes for the service.
           • name type string
             The name of the attribute. List of valid attribute names mainatined separately.
           • description type string
             Description of the attribute - may be displayed directly to an end user.
           • value type string
             The value of the attribute. Valid values will depend on the attribute dataType.
       • serviceEndpoints type ArrayOfServiceEndpoints
         A list of endpoints for the service which can be used programmatically by a consuming system.
         • endpoint - optional, unbounded, nillable; type Endpoint
           • endpointOrder type int
             The order of the endpoint within the list when sort order is applied using this field.
           • transport type string
             The type of endpoint / transport (e.g. http, itk, email).
           • format type string
             The format of the interaction for this endpoint (e.g. CDA, HTML, FHIR)
           • interaction type string
             An interaction identifier to denote the type of business interaction that the endpoint supports.
           • businessScenario type string
             The business scenario in which this endpoint should be used. "Primary" denotes an interaction resulting in action / direct care, "Copy" denotes an interaction for information purposes.
           • address type string
             The URI of some kind to be used for addressing the endpoint.
           • compression type string
             A field to denote whether the payload should be compressed for this endpoint (not used for all endpoint types).
           • comment type string
             Free text notes that may be used to support the use of the endpoint (not used for all endpoint types). May be displayed directly to an end user.
       • rotaSessions - optional; type ArrayOfServiceCareItemRotaSession
         A list of rota sessions specifying the opening times for the service. This list represents a regular weekly pattern.
         • serviceCareItemRotaSession - optional, unbounded, nillable; type ServiceCareItemRotaSession
           • startDayOfWeek type DayOfWeek - type string with restriction - enum { 'Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Bankholiday' }
             The day of the week on which this session starts.
           • startTime - optional; type TimeOfDay
             The time of day at which this session starts.
             • hours type short
             • minutes type short
           • endDayOfWeek type DayOfWeek - type string with restriction - enum { 'Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Bankholiday' }
             The day of the week on which this session ends.
           • endTime - optional; type TimeOfDay
             The time of day at which this session ends.
             • hours type short
             • minutes type short
           • status - optional; type string
             Whether this session represents that the service is Open or Closed.
       • openTimeSpecifiedSessions - optional; type ArrayOfOpenTimeSpecified
         A list of exceptional opening time sessions, which may override those defined in the regular rota sessions list.
         • openTimeSpecified - optional, unbounded, nillable; type string
       • attributes - optional; type ArrayOfAttributes
         A list of attributes relating to the service. A list of valid service attributes is maintained separately - new attribute items can be introduced outside of the schema. Absence of an attribute in the list signifies that it is not populated for the service.
         • attribute - optional, unbounded, nillable; type Attribute
           • dataType type string
             Value indicating the data type for the value of this attribute. List of valid dataTypes maintained separately.
           • name type string
             The name of the attribute. List of valid attribute names mainatined separately.
           • description type string
             Description of the attribute - may be displayed directly to an end user.
           • value type string
             The value of the attribute. Valid values will depend on the attribute dataType.
       • serviceAgeRange type ArrayOfServiceAgeRanges
         The list of age ranges supported by the service. A patient's age must fall within a specified age range to be eligible to receive care from the service.
         • ageRange - optional, unbounded, nillable; type AgeRange
           • daysFrom type float
             The lower bound of the age range - in days.
           • daysTo type float
             The upper bound of the age range - in days.
2. GetHospitalScores
   Source code
   Description:
   Returns a list of Emergency Departments with OHA (pressure) scores.
   Style:
   document
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   https://nww.pathwaysdos.nhs.uk/app/api/webservices/GetHospitalScores
   Input:
   GetHospitalScoresSoapIn (soap12:header, use = literal, part = ServiceVersion)Source code
   parameters type GetHospitalScores

   • userInfo - optional; type UserInfo
     • username type string
     • password type string
   Output:
   GetHospitalScoresSoapOut (soap12:body, use = literal)Source code
   parameters type GetHospitalScoresResponse

   • GetHospitalScoresResult - optional; type ArrayOfHospitalScores
     • hospital - optional, unbounded, nillable; type Hospital
       A list of Emergency Departments with pressure scores.
       • hospital_name type string
         The name of the Emergency Department.
       • total_score type int
         The pressure score for the Emergency Department.
       • note type string
         The latest note about the Emergency Department capacity.
       • update_date type string
         The time at which the capacity was last updated.
3. ServiceDetailsById
   Source code
   Description:
   Returns a list of service endpoint details for a specified single service.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   https://nww.pathwaysdos.nhs.uk/app/api/webservices/ServiceDetailsById
   Input:
   ServiceDetailsByIdRequest (soap12:header, use = literal, part = ServiceVersion)Source code
   parameters type ServiceDetailsById

   • userInfo type UserInfo
     • username type string
     • password type string
   • serviceId type string
     The identifier for the required service.
   Output:
   ServiceDetailsByIdResponse (soap12:body, use = literal)Source code
   parameters type ServiceDetailsByIdResponse

   • services - optional; type ArrayOfServices
     • service - optional, unbounded, nillable; type ServiceDetail
       • id type string
         The service identifier for the service.
       • odsCode type string
         The value of the ODS code field for the service. NOTE: Values in this field are not automatically validated, and therefore cannot be considered guarranteed ODS codes at present.
       • serviceEndpoints - optional; type ArrayOfServiceEndpoints
         A list of service endpoints for the service.
         • endpoint - optional, unbounded, nillable; type Endpoint
           • endpointOrder type int
             The order of the endpoint within the list when sort order is applied using this field.
           • transport type string
             The type of endpoint / transport (e.g. http, itk, email).
           • format type string
             The format of the interaction for this endpoint (e.g. CDA, HTML, FHIR)
           • interaction type string
             An interaction identifier to denote the type of business interaction that the endpoint supports.
           • businessScenario type string
             The business scenario in which this endpoint should be used. "Primary" denotes an interaction resulting in action / direct care, "Copy" denotes an interaction for information purposes.
           • address type string
             The URI of some kind to be used for addressing the endpoint.
           • compression type string
             A field to denote whether the payload should be compressed for this endpoint (not used for all endpoint types).
           • comment type string
             Free text notes that may be used to support the use of the endpoint (not used for all endpoint types). May be displayed directly to an end user.